| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ContentLoadResult.h
1 // ContentLoadResult.h
3 //
5
6 namespace nkScripts
7 {
11 enum class CONTENT_LOAD_RESULT_STATE
12 {
13 SUCCESS = 0,
14 PARTIAL,
15 FAILURE
16 } ;
17
21 template<typename T>
22 class ContentLoadResult
23 {
24 public :
25
26 nkMemory::BufferCast<nkMemory::String> _errorMessages ;
27 nkMemory::BufferCast<T*> _loadResult ;
28 CONTENT_LOAD_RESULT_STATE _success = CONTENT_LOAD_RESULT_STATE::SUCCESS ;
29 } ;
30
31 using ContentLoadResultScript = ContentLoadResult<Script> ;
32 }
nkScripts::CONTENT_LOAD_RESULT_STATE
CONTENT_LOAD_RESULT_STATE
Describes a loading result state.
Definition: ContentLoadResult.h:12
nkScripts
Encompasses all API of component NilkinsScripts.
Definition: Environment.h:7
nkScripts::ContentLoadResult::_loadResult
nkMemory::BufferCast< T * > _loadResult
The list of all content that could be successfully parsed.
Definition: ContentLoadResult.h:27
nkScripts::ContentLoadResult
Holds information about a content load attempt.
Definition: ContentLoadResult.h:23
nkScripts::ContentLoadResult::_errorMessages
nkMemory::BufferCast< nkMemory::String > _errorMessages
The list of descriptions of messages encountered, if any.
Definition: ContentLoadResult.h:26
nkScripts::ContentLoadResult::_success
CONTENT_LOAD_RESULT_STATE _success
The final status of the content loading attempt.
Definition: ContentLoadResult.h:28
nkScripts::CONTENT_LOAD_RESULT_STATE::FAILURE
@ FAILURE
Loading could not load anything.
nkMemory::BufferCast< nkMemory::String >
nkScripts::CONTENT_LOAD_RESULT_STATE::SUCCESS
@ SUCCESS
Loading went without problem.
nkScripts::CONTENT_LOAD_RESULT_STATE::PARTIAL
@ PARTIAL
Loading could load part of the data, but some other had errors.